<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>sysmon: xsysmon_aux_polled_example.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">sysmon
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xsysmon__aux__polled__example_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xsysmon_aux_polled_example.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains a design example using the driver functions of the System Monitor/ADC driver. </p>
<p>This example shows the usage of the driver/device in polled mode with external mux and XADC in continuous pass Sequencer mode. It is provided to illustrate the usage of external mux.</p>
<pre></pre><pre>MODIFICATION HISTORY:</pre><pre>Ver   Who    Date     Changes
</p>
<hr/>
<p>
7.5   mn     09/12/18 First release
7.8   cog    07/20/23 Added support for SDT flow
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ad8d0b9e2ee5e4dbbfd83ea1453b20d0a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xsysmon__aux__polled__example_8c.html#ad8d0b9e2ee5e4dbbfd83ea1453b20d0a">SysMonAuxPolledExample</a> (u16 SysMonDeviceId)</td></tr>
<tr class="memdesc:ad8d0b9e2ee5e4dbbfd83ea1453b20d0a"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function runs a test on the System Monitor/ADC device using the driver APIs.  <a href="#ad8d0b9e2ee5e4dbbfd83ea1453b20d0a">More...</a><br/></td></tr>
<tr class="separator:ad8d0b9e2ee5e4dbbfd83ea1453b20d0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a840291bc02cba5474a4cb46a9b9566fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xsysmon__aux__polled__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main</a> (void)</td></tr>
<tr class="memdesc:a840291bc02cba5474a4cb46a9b9566fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function that invokes the polled example in this file.  <a href="#a840291bc02cba5474a4cb46a9b9566fe">More...</a><br/></td></tr>
<tr class="separator:a840291bc02cba5474a4cb46a9b9566fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a840291bc02cba5474a4cb46a9b9566fe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Main function that invokes the polled example in this file. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None.</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if the example has completed successfully.</li>
<li>XST_FAILURE if the example has failed.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="xsysmon__aux__polled__example_8c.html#ad8d0b9e2ee5e4dbbfd83ea1453b20d0a">SysMonAuxPolledExample()</a>.</p>

</div>
</div>
<a class="anchor" id="ad8d0b9e2ee5e4dbbfd83ea1453b20d0a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int SysMonAuxPolledExample </td>
          <td>(</td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>SysMonDeviceId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function runs a test on the System Monitor/ADC device using the driver APIs. </p>
<p>This function does the following tasks:</p>
<ul>
<li>Initiate the XADC device driver instance</li>
<li>Run self-test on the device</li>
<li>Reset the device</li>
<li>Set up sequencer registers to continuously monitor the auxiliary channels available in XADC</li>
<li>Set up configuration registers to start the sequencer in continuous pass mode</li>
<li>Wait until End of sequence interrupt occurs and read the conversion data</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">SysMonDeviceId</td><td>is the XPAR_&lt;SYSMON_ADC_instance&gt;_DEVICE_ID value from xparameters.h.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if the example has completed successfully.</li>
<li>XST_FAILURE if the example has failed.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

<p>References <a class="el" href="struct_x_sys_mon___config.html#a0c21814e1533c922ccbb0a70bf60261f">XSysMon_Config::BaseAddress</a>, <a class="el" href="group___overview.html#ga7cd77d90e7456614726390476f3636c8">XSM_AVG_16_SAMPLES</a>, <a class="el" href="group___overview.html#ga41aa90146d4e0786b8d36888e44aac34">XSM_CH_AUX_MIN</a>, <a class="el" href="group___overview.html#ga7a2f95ce30a1155b39edd9384e6d898a">XSM_SEQ_CH_AUX00</a>, <a class="el" href="group___overview.html#ga090e870886f3ed8d58efc57c763772f2">XSM_SEQ_MODE_CONTINPASS</a>, <a class="el" href="group___overview.html#ga223c74befcd8a6710ea7a7acbaf41636">XSM_SEQ_MODE_SAFE</a>, <a class="el" href="group___overview.html#gac10ed891373f4799aa33110441cb5595">XSM_SR_EOS_MASK</a>, <a class="el" href="group___overview.html#ga04de4a4efc9fab7a41b88166bbffc615">XSysMon_CfgInitialize()</a>, <a class="el" href="group___overview.html#ga07ab2025481799032cd40ff62f4b10f6">XSysMon_GetAdcData()</a>, <a class="el" href="group___overview.html#ga34d731dace546db3397741f0d229cb3b">XSysMon_GetStatus()</a>, <a class="el" href="group___overview.html#gaf2f837d4a34ab56e268078a2874389d4">XSysMon_LookupConfig()</a>, <a class="el" href="group___overview.html#ga2b75d20fe44358333e528a14340568ce">XSysMon_RawToVoltage</a>, <a class="el" href="group___overview.html#ga23b6bce798cabbee7cb637d36edd54da">XSysMon_SelfTest()</a>, <a class="el" href="group___overview.html#ga3c119682ea951295d41462e329da881a">XSysMon_SetAdcClkDivisor()</a>, <a class="el" href="group___overview.html#gaf3504732dccf017f38fa7ffd7483f358">XSysMon_SetAvg()</a>, <a class="el" href="group___overview.html#gaa5e941d4d6d614920634a8ff1925cbfd">XSysMon_SetExtenalMux()</a>, <a class="el" href="group___overview.html#gaeafd06e40eff4807b362edf043d725e8">XSysMon_SetSeqAcqTime()</a>, <a class="el" href="group___overview.html#gae7072bfa213b7318fcc29408a459c0bb">XSysMon_SetSeqAvgEnables()</a>, <a class="el" href="group___overview.html#ga60d92b3a70aab326364319b3d1f1a7cc">XSysMon_SetSeqChEnables()</a>, <a class="el" href="group___overview.html#ga3d3d8052fae049f4ca772b5956ced31f">XSysMon_SetSeqInputMode()</a>, and <a class="el" href="group___overview.html#ga433e353cd5a25454ce2a6da51494e478">XSysMon_SetSequencerMode()</a>.</p>

<p>Referenced by <a class="el" href="xsysmon__aux__polled__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
